home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / print / wsd40e.zip / WSD / WSD-ENG.DOC < prev    next >
Text File  |  1992-06-17  |  55KB  |  1,265 lines
  1. (* ------------------------------------------------------------------
  2.  Helmut Steeb  03.07.91 TURBO-PASCAL 5.5
  3.  S+C-AT 286, Herculesgraphik, 1MB RAM, MS-DOS 3.30
  4.  486/33, VGA-Graphik, 4MB RAM, DR-DOS 6.0
  5.  WSD-ENG.DOC
  6.  From: 17.06.92
  7. ------------------------------------------------------------------ *)
  8.  
  9.  
  10.  
  11. ──────┤ WSD ─ your text formatter by Helmut Steeb ├──────
  12.  
  13. Contents
  14. --------
  15.  
  16. What is WSD?
  17. A short introduction
  18. Description of files
  19. How to install WSD
  20. Formatting texts with WSD
  21.   How to start WSD
  22.   Printing modi
  23.   Escape characters
  24.   Additional escapes in head and foot lines
  25.   Page layout
  26.   Shortcuts for escapes
  27.  
  28. Appendix
  29. A) Printer requirements
  30. B) List of dot commands
  31. C) How to construct your proportional table
  32. D) Bugs, problems, missing features
  33.  
  34. ------------------------------------------------------------------
  35.  
  36. What is WSD?
  37. ------------
  38.  
  39. WSD is "yet another text formatter". Its functionality is styled
  40. similiar to WordStar 3.0. In fact, I made the first version of WSD
  41. because WordStar 3.0 lacked some features which I'd liked to have.
  42. These are especially printing user defined fonts, printing in double
  43. height and with several printing features the printer supported. "WSD"
  44. means "Word Star Druck" (Word Star Printing). But Word Star was not
  45. the last word to WSD. I have worked on WSD continuously. Today, the
  46. most important features of WSD are:
  47.  
  48. - printing ONLY on 24-dot matrix printers (at the moment)
  49.  
  50. - WSD formats your text in proportional spacing, with left and right
  51.   justification. Proportional spacing is the most readable print style
  52.   - characters are of different width, then, e.g., "i" is not as wide
  53.   as "w".
  54.  
  55. - Automatic hyphenation!
  56.  
  57. - Checking your text file in advance before actually printing
  58.  
  59. - Print styles can be mixed:
  60.  
  61.   * Proportional spacing normal/narrow, 10 cpi (characters per inch,
  62.     the usual spacing), 12 cpi, 15 cpi, 17 cpi and 20 cpi (narrower)
  63.  
  64.   * LQ (letter quality) or draft quality
  65.  
  66.   * Printer internal or user defined fonts (for foreign language
  67.     characters, calligraphic fonts, maths...)
  68.  
  69.   * double wide and double high print style, italics, underline, bold,
  70.     superscript, subscipt.
  71.  
  72.     NOTE: double high print style is not correctly taken into account
  73.       for vertical page layout at the present.
  74.  
  75. - page format with one or two columns (to be mixed on the same page)
  76.  
  77. - page style "normal" / only "left" pages / only "right" pages /
  78.   twosided
  79.  
  80. - variable line spacing 8 / 6 / 4 lines per inch (the same as 0.5 / 1
  81.   / 1.5 on some typewriters).
  82.  
  83. - WSD is a mere text formatter. The printing features (italics,
  84.   underlined, etc.) are not visible on screen, only on paper you will
  85.   see them. This is not "what you see is what you get". You write your
  86.   text with your favourite text editor (I am using QEdit, by the way).
  87.   WSD will do the formatting and printing.
  88.  
  89.   To control printing, you add formatting commands to your text. These
  90.   are:
  91.  
  92.   * "escapes", following after the "escape character" "#". For
  93.     example, "#K" means "italics on", and "#k" means "italics off".
  94.  
  95.   * "short cuts" (abbreviations) of escapes. Short cuts for escapes
  96.     are not important at the beginning. More about them can be found
  97.     below (I don't use these very often).
  98.  
  99.   * "dot commands". Their purpose is in general to control printing
  100.     layout. Dot commands are text lines which start with a dot in the
  101.     first text column (in regular text lines, this is assumed to never
  102.     occur). These lines with a dot in the first column are only to
  103.     define layout features. They will NOT be printed. For example, to
  104.     switch to two column printing, you would use the following command
  105.     placed in the first print column:
  106.  
  107.     .2c
  108.  
  109. ------------------------------------------------------------------
  110.  
  111. Short introduction
  112. ------------------
  113.  
  114. I suppose, before reading all the rest of this text, you'd like to get
  115. a quick taste about WSD. My proposal: just give it a try now!
  116.  
  117. To this end, all files of the WSD archive should be together in a
  118. subdirectory. Now change dir to that directory, e.g.,
  119.  
  120. A:
  121. CD WSD
  122.  
  123. and make your printer ready. NOTE: the print head should be
  124. immediately below the top paper border (if you are using a sheet
  125. feeder, we must think a bit over that. May be this can be managed by
  126. adjusting the paper layout, i.e., you should then decrease the top
  127. margin and increase the bottom margin. See below on these notions).
  128. Now start WSD by
  129.  
  130. WSD -c WSDDEMO
  131.  
  132. WSD will check (-c) the file WSDDEMO.TXT and tell you that no error
  133. occured (by adding -c, you can always suppress printing to only check
  134. the input file). Fine! Now becoming serious, type
  135.  
  136. WSD WSDDEMO
  137.  
  138. Afterwards, (hopefully) you see your first WSD formatted text on the
  139. printer. It is a demo, so don't bother that it is in German language.
  140. Just enjoy the printing features. If there are some less beautiful
  141. phenomena, you should seemingly proper install WSD to your printer.
  142. For printers as NEC P6, there should be no problems. If you like it,
  143. go on trying some more texts. Or just more promising, have a try with
  144.  
  145. LISTING WSD-ENG.DOC
  146.  
  147. Be told again: if you add option -c when calling WSD, then the input
  148. file will only be checked, not actually be printed. As a side effect
  149. you will see the number of pages needed.
  150.  
  151. You can also print first all pages with odd page numbers, then turn
  152. the sheet round, then print all pages with even page numbers:
  153.  
  154. LISTING WSD-ENG.DOC /po
  155.   ... turn all round ...
  156. LISTING WSD-ENG.DOC /pe
  157.  
  158. If you like it still smaller, do it with LISTING1 instead.
  159.  
  160. Some remarks are in order here (for details see the following
  161. chapters):
  162.  
  163. - the batch files LISTING.BAT etc. all call the WSD.EXE program. If
  164.   there are problems, make sure that LISTING.BAT etc. contains the
  165.   correct actual path to WSD.EXE.
  166.  
  167. - the files FONTTST1.TXT, FONTTST2.TXT and SAMPLE.TXT all try to print
  168.   user defined fonts. This will only work if your printer is prepared
  169.   to print user defined fonts, and if the file WSD.CFG contains the
  170.   correct path to the fonts (entry FO=xxx; the fonts are all named
  171.   with extension .LET and come in the LETTER subdirectory). You can
  172.   always print these files with LISTING because LISTING suppresses the
  173.   font switching commands.
  174.  
  175. ------------------------------------------------------------------
  176.  
  177. Description of files
  178. --------------------
  179.  
  180. WSD is no "integrated" environment as some commercial available
  181. programs are. The formatting process is controlled by some files which
  182. are read by WSD at program start. You can easily adapt these files
  183. using a simple text editor.
  184.  
  185. WSD      EXE          The program
  186.  
  187. WSD      MSG          message file
  188.   MUST be available at program start. Without this file, WSD would not
  189.   be able to communicate with you. The idea behind this is to allow
  190.   simple adaptation to various languages. Actually, you need not copy
  191.   your adapted file onto WSD.MSG. On startup, WSD first checks the
  192.   value of the environment variable WSDMSG and tries to read that
  193.   file. If this succeeds, WSD.MSG need not be there. For further
  194.   information see below in the chapter on Installing WSD.
  195.  
  196. WSD      CFG          configuration file
  197.  
  198.   MUST be available at program start. You can write a configuration
  199.   file of your own and tell WSD to use that via a command line
  200.   parameter. In the configuration file, some general data for
  201.   formatting are specified. These are tabulator width, for example, as
  202.   well as the names of other files used by WSD (hyphenation info,
  203.   printer information, etc.).
  204.  
  205. NECP6    ESC
  206.   MUST be available at program start. The name of the file to use is
  207.   specified in the configuration file. This file defines the
  208.   connection of text characters following "#" with printer escape
  209.   sequences. For example, the file says that the character sequence
  210.   "#K" in your text will be replaced by the printer codes ESCAPE "4"
  211.   (ESCAPE is a special character for printer control). On most
  212.   printers, ESCAPE "4" will switch to italic printing. Besides that,
  213.   the file conta